/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2019 Hellobike Group
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

package com.hellobike.flutter.thrio.navigator

interface RouteObserver {
    /**
     * The [ThrioNavigator] pushed `route`.
     *
     * The route immediately below that one, and thus the previously active
     * route, is `previousRoute`.
     */
    fun didPush(routeSettings: RouteSettings) {}

    /**
     * The [ThrioNavigator] popped `route`.
     *
     * The route immediately below that one, and thus the newly active
     * route, is `previousRoute`.
     */
    fun didPop(routeSettings: RouteSettings) {}

    /**
     * The [ThrioNavigator] popped to `route`.
     *
     * The previously active route, is `previousRoute`.
     */
    fun didPopTo(routeSettings: RouteSettings) {}

    /**
     * The [ThrioNavigator] removed `route`.
     *
     * The route immediately below that one, if any, is `previousRoute`.
     */
    fun didRemove(routeSettings: RouteSettings) {}

}